@typescript-eslint/parser

What is @typescript-eslint/parser?

The @typescript-eslint/parser is an ESLint parser that allows for the analysis and linting of TypeScript code. It is part of the TypeScript-ESLint project, which aims to bring ESLint's powerful static analysis capabilities to TypeScript codebases. The parser converts TypeScript source code into an ESTree-compatible form so that it can be used by ESLint for linting and other code analysis tasks.

What are @typescript-eslint/parser's main functionalities?

Parsing TypeScript code

This feature allows the parser to read TypeScript files and produce an abstract syntax tree (AST) that is compatible with ESLint, enabling it to understand and lint TypeScript syntax.

const { ESLint } = require('eslint');

async function main() {
  const eslint = new ESLint({
    parser: '@typescript-eslint/parser',
    parserOptions: {
      ecmaVersion: 2020,
      sourceType: 'module',
      project: './tsconfig.json'
    }
  });

  const results = await eslint.lintFiles(['src/**/*.ts']);
  // Handle the results
}

main();

Integration with ESLint rules

The parser can be used in conjunction with ESLint rules, including those specifically designed for TypeScript, to enforce code quality and style guidelines.

module.exports = {
  parser: '@typescript-eslint/parser',
  extends: [
    'plugin:@typescript-eslint/recommended'
  ],
  rules: {
    '@typescript-eslint/no-unused-vars': 'error',
    '@typescript-eslint/explicit-function-return-type': 'warn'
  }
};

Other packages similar to @typescript-eslint/parser

babel-eslint

babel-eslint is an ESLint parser that allows you to lint all valid Babel code with ESLint. While it is not specifically designed for TypeScript, it can be used to lint code that uses Babel for transpilation, including TypeScript when used with the appropriate Babel plugins.

eslint-plugin-typescript

This is a deprecated package that was used to provide ESLint rules for TypeScript before the TypeScript-ESLint project was created. It has been replaced by the @typescript-eslint/parser and typescript-eslint/eslint-plugin packages.

README

@typescript-eslint/parser

An ESLint parser which leverages TypeScript ESTree to allow for ESLint to lint TypeScript source code.

👉 See https://typescript-eslint.io/packages/parser for documentation on this package.

See https://typescript-eslint.io for general documentation on typescript-eslint, the tooling that allows you to run ESLint and Prettier on TypeScript code.

Changelog

6.21.0 (2024-02-05)

🚀 Features

• export plugin metadata (#8331)
• allow parserOptions.project: false (#8339)
• eslint-plugin: add rule prefer-find (#8216)
• typescript-estree: forbid duplicated accessibility modifiers (#8257)
• utils: improve eslint types (#8344)

🩹 Fixes

• ast-spec: add JSXElement type to the JSXAttribute['value'] (#8285)
• eslint-plugin: [no-unused-vars] don't report on types referenced in export assignment expression (#8265)
• eslint-plugin: [switch-exhaustiveness-check] better support for intersections, infinite types, non-union values (#8250)
• eslint-plugin: [consistent-type-imports] dont report on types used in export assignment expressions (#8332)
• eslint-plugin: [no-unnecessary-condition] handle left-hand optional with exactOptionalPropertyTypes option (#8249)
• eslint-plugin: [class-literal-property-style] allow getter when same key setter exists (#8277)
• eslint-plugin: [no-unnecessary-type-assertion] provide valid fixes for assertions with extra tokens before as keyword (#8326)
• rule-tester: fix a phantom dependency on the "semver" package (#8260)

❤️ Thank You

• auvred @auvred
• Brad Zacher @bradzacher
• Kirk Waiblinger @kirkwaiblinger
• Pete Gonzalez @octogonz
• YeonJuan @yeonjuan

You can read about our versioning strategy and releases on our website.